/*
 * This file is part of Catfish.
 * Copyright (C) 2010 Namazu Studios LLC
 * 
 * Catfish is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as 
 * published by the Free Software Foundation, either version 3 of 
 * the License, or (at your option) any later version.
 * 
 * Catfish is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with Catfish.  If not, please visit:
 *  
 * http://www.gnu.org/licenses/
 *  
 */
package com.namazustudios.catfish.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * When putting data data object into the data store, a method annotated with
 * this annotation will be called.  For example:
 * 
 * <code>
 * @PrePut
 * void foo(Catfish catfish) {
 *     System.out.printf("Foo called.");
 * }
 * </code>
 * 
 * Will result in "Foo called." being printed to the console just after this
 * object is put into the datastore.  The object may have access to the entity
 * actually stored to the datastore.  This could be useful for implementing
 * expando-like behavior in objects.
 * 
 * <code>
 * @PrePut
 * void foo(Catfish catfish, Entity entity) {
 *     System.out.printf("Foo called.");
 * }
 * 
 * </code>
 * 
 * @author patrick
 * 
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface PostPut {}
